Beta: Get document information Beta

Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice.

Tip: Refer to the Troubleshooting tutorial for more information.

SecurityBearerAuth
Request
path Parameters
datasource
required
string

The datasource to which the document belongs

Request Body schema: application/json; charset=UTF-8
required
objectType
required
string

Object type of the document to get the status for.

docId
required
string

Glean Document ID within the datasource to get the status for.

Responses
200

OK

Response Schema: application/json; charset=UTF-8
object (DocumentStatusResponse)

Describes the document status response body

object (DocumentPermissionsDefinition)

describes the access control details of the document

400

Bad Request

401

Not Authorized

post/debug/{datasource}/document
Request samples
application/json; charset=UTF-8
{
  • "objectType": "Article",
  • "docId": "art123"
}
Response samples
application/json; charset=UTF-8
{
  • "status": {
    • "uploadStatus": "UPLOADED",
    • "lastUploadedAt": "2021-08-06T17:58:01.000Z",
    • "indexingStatus": "INDEXED",
    • "lastIndexedAt": "2021-08-06T17:58:01.000Z"
    },
  • "uploadedPermissions": {
    • "allowedUsers": [
      • {
        • "email": "string",
        • "datasourceUserId": "string",
        • "name": "string"
        }
      ],
    • "allowedGroups": [
      • "string"
      ],
    • "allowedGroupIntersections": [
      • {
        • "requiredGroups": [
          • "string"
          ]
        }
      ],
    • "allowAnonymousAccess": true,
    • "allowAllDatasourceUsersAccess": true
    }
}